<HTML>
<BODY BGCOLOR="white">
<PRE>
<FONT color="green">001</FONT>    /* ===========================================================<a name="line.1"></a>
<FONT color="green">002</FONT>     * JFreeChart : a free chart library for the Java(tm) platform<a name="line.2"></a>
<FONT color="green">003</FONT>     * ===========================================================<a name="line.3"></a>
<FONT color="green">004</FONT>     *<a name="line.4"></a>
<FONT color="green">005</FONT>     * (C) Copyright 2000-2011, by Object Refinery Limited and Contributors.<a name="line.5"></a>
<FONT color="green">006</FONT>     *<a name="line.6"></a>
<FONT color="green">007</FONT>     * Project Info:  http://www.jfree.org/jfreechart/index.html<a name="line.7"></a>
<FONT color="green">008</FONT>     *<a name="line.8"></a>
<FONT color="green">009</FONT>     * This library is free software; you can redistribute it and/or modify it<a name="line.9"></a>
<FONT color="green">010</FONT>     * under the terms of the GNU Lesser General Public License as published by<a name="line.10"></a>
<FONT color="green">011</FONT>     * the Free Software Foundation; either version 2.1 of the License, or<a name="line.11"></a>
<FONT color="green">012</FONT>     * (at your option) any later version.<a name="line.12"></a>
<FONT color="green">013</FONT>     *<a name="line.13"></a>
<FONT color="green">014</FONT>     * This library is distributed in the hope that it will be useful, but<a name="line.14"></a>
<FONT color="green">015</FONT>     * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY<a name="line.15"></a>
<FONT color="green">016</FONT>     * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public<a name="line.16"></a>
<FONT color="green">017</FONT>     * License for more details.<a name="line.17"></a>
<FONT color="green">018</FONT>     *<a name="line.18"></a>
<FONT color="green">019</FONT>     * You should have received a copy of the GNU Lesser General Public<a name="line.19"></a>
<FONT color="green">020</FONT>     * License along with this library; if not, write to the Free Software<a name="line.20"></a>
<FONT color="green">021</FONT>     * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301,<a name="line.21"></a>
<FONT color="green">022</FONT>     * USA.<a name="line.22"></a>
<FONT color="green">023</FONT>     *<a name="line.23"></a>
<FONT color="green">024</FONT>     * [Oracle and Java are registered trademarks of Oracle and/or its affiliates. <a name="line.24"></a>
<FONT color="green">025</FONT>     * Other names may be trademarks of their respective owners.]<a name="line.25"></a>
<FONT color="green">026</FONT>     *<a name="line.26"></a>
<FONT color="green">027</FONT>     * ----------------------------<a name="line.27"></a>
<FONT color="green">028</FONT>     * BoxAndWhiskerCalculator.java<a name="line.28"></a>
<FONT color="green">029</FONT>     * ----------------------------<a name="line.29"></a>
<FONT color="green">030</FONT>     * (C) Copyright 2003-2008,  by Object Refinery Limited and Contributors.<a name="line.30"></a>
<FONT color="green">031</FONT>     *<a name="line.31"></a>
<FONT color="green">032</FONT>     * Original Author:  David Gilbert (for Object Refinery Limited);<a name="line.32"></a>
<FONT color="green">033</FONT>     * Contributor(s):   -;<a name="line.33"></a>
<FONT color="green">034</FONT>     *<a name="line.34"></a>
<FONT color="green">035</FONT>     * Changes<a name="line.35"></a>
<FONT color="green">036</FONT>     * -------<a name="line.36"></a>
<FONT color="green">037</FONT>     * 28-Aug-2003 : Version 1 (DG);<a name="line.37"></a>
<FONT color="green">038</FONT>     * 17-Nov-2003 : Fixed bug in calculations of outliers and median (DG);<a name="line.38"></a>
<FONT color="green">039</FONT>     * 10-Jan-2005 : Removed deprecated methods in preparation for 1.0.0<a name="line.39"></a>
<FONT color="green">040</FONT>     *               release (DG);<a name="line.40"></a>
<FONT color="green">041</FONT>     * ------------- JFREECHART 1.0.x ---------------------------------------------<a name="line.41"></a>
<FONT color="green">042</FONT>     * 15-Nov-2006 : Cleaned up handling of null arguments, and null or NaN items<a name="line.42"></a>
<FONT color="green">043</FONT>     *               in the list (DG);<a name="line.43"></a>
<FONT color="green">044</FONT>     *<a name="line.44"></a>
<FONT color="green">045</FONT>     */<a name="line.45"></a>
<FONT color="green">046</FONT>    <a name="line.46"></a>
<FONT color="green">047</FONT>    package org.jfree.data.statistics;<a name="line.47"></a>
<FONT color="green">048</FONT>    <a name="line.48"></a>
<FONT color="green">049</FONT>    import java.util.ArrayList;<a name="line.49"></a>
<FONT color="green">050</FONT>    import java.util.Collections;<a name="line.50"></a>
<FONT color="green">051</FONT>    import java.util.Iterator;<a name="line.51"></a>
<FONT color="green">052</FONT>    import java.util.List;<a name="line.52"></a>
<FONT color="green">053</FONT>    <a name="line.53"></a>
<FONT color="green">054</FONT>    /**<a name="line.54"></a>
<FONT color="green">055</FONT>     * A utility class that calculates the mean, median, quartiles Q1 and Q3, plus<a name="line.55"></a>
<FONT color="green">056</FONT>     * a list of outlier values...all from an arbitrary list of<a name="line.56"></a>
<FONT color="green">057</FONT>     * &lt;code&gt;Number&lt;/code&gt; objects.<a name="line.57"></a>
<FONT color="green">058</FONT>     */<a name="line.58"></a>
<FONT color="green">059</FONT>    public abstract class BoxAndWhiskerCalculator {<a name="line.59"></a>
<FONT color="green">060</FONT>    <a name="line.60"></a>
<FONT color="green">061</FONT>        /**<a name="line.61"></a>
<FONT color="green">062</FONT>         * Calculates the statistics required for a {@link BoxAndWhiskerItem}<a name="line.62"></a>
<FONT color="green">063</FONT>         * from a list of &lt;code&gt;Number&lt;/code&gt; objects.  Any items in the list<a name="line.63"></a>
<FONT color="green">064</FONT>         * that are &lt;code&gt;null&lt;/code&gt;, not an instance of &lt;code&gt;Number&lt;/code&gt;, or<a name="line.64"></a>
<FONT color="green">065</FONT>         * equivalent to &lt;code&gt;Double.NaN&lt;/code&gt;, will be ignored.<a name="line.65"></a>
<FONT color="green">066</FONT>         *<a name="line.66"></a>
<FONT color="green">067</FONT>         * @param values  a list of numbers (a &lt;code&gt;null&lt;/code&gt; list is not<a name="line.67"></a>
<FONT color="green">068</FONT>         *                permitted).<a name="line.68"></a>
<FONT color="green">069</FONT>         *<a name="line.69"></a>
<FONT color="green">070</FONT>         * @return A box-and-whisker item.<a name="line.70"></a>
<FONT color="green">071</FONT>         */<a name="line.71"></a>
<FONT color="green">072</FONT>        public static BoxAndWhiskerItem calculateBoxAndWhiskerStatistics(<a name="line.72"></a>
<FONT color="green">073</FONT>                                            List values) {<a name="line.73"></a>
<FONT color="green">074</FONT>            return calculateBoxAndWhiskerStatistics(values, true);<a name="line.74"></a>
<FONT color="green">075</FONT>        }<a name="line.75"></a>
<FONT color="green">076</FONT>    <a name="line.76"></a>
<FONT color="green">077</FONT>        /**<a name="line.77"></a>
<FONT color="green">078</FONT>         * Calculates the statistics required for a {@link BoxAndWhiskerItem}<a name="line.78"></a>
<FONT color="green">079</FONT>         * from a list of &lt;code&gt;Number&lt;/code&gt; objects.  Any items in the list<a name="line.79"></a>
<FONT color="green">080</FONT>         * that are &lt;code&gt;null&lt;/code&gt;, not an instance of &lt;code&gt;Number&lt;/code&gt;, or<a name="line.80"></a>
<FONT color="green">081</FONT>         * equivalent to &lt;code&gt;Double.NaN&lt;/code&gt;, will be ignored.<a name="line.81"></a>
<FONT color="green">082</FONT>         *<a name="line.82"></a>
<FONT color="green">083</FONT>         * @param values  a list of numbers (a &lt;code&gt;null&lt;/code&gt; list is not<a name="line.83"></a>
<FONT color="green">084</FONT>         *                permitted).<a name="line.84"></a>
<FONT color="green">085</FONT>         * @param stripNullAndNaNItems  a flag that controls the handling of null<a name="line.85"></a>
<FONT color="green">086</FONT>         *     and NaN items.<a name="line.86"></a>
<FONT color="green">087</FONT>         *<a name="line.87"></a>
<FONT color="green">088</FONT>         * @return A box-and-whisker item.<a name="line.88"></a>
<FONT color="green">089</FONT>         *<a name="line.89"></a>
<FONT color="green">090</FONT>         * @since 1.0.3<a name="line.90"></a>
<FONT color="green">091</FONT>         */<a name="line.91"></a>
<FONT color="green">092</FONT>        public static BoxAndWhiskerItem calculateBoxAndWhiskerStatistics(<a name="line.92"></a>
<FONT color="green">093</FONT>                List values, boolean stripNullAndNaNItems) {<a name="line.93"></a>
<FONT color="green">094</FONT>    <a name="line.94"></a>
<FONT color="green">095</FONT>            if (values == null) {<a name="line.95"></a>
<FONT color="green">096</FONT>                throw new IllegalArgumentException("Null 'values' argument.");<a name="line.96"></a>
<FONT color="green">097</FONT>            }<a name="line.97"></a>
<FONT color="green">098</FONT>    <a name="line.98"></a>
<FONT color="green">099</FONT>            List vlist;<a name="line.99"></a>
<FONT color="green">100</FONT>            if (stripNullAndNaNItems) {<a name="line.100"></a>
<FONT color="green">101</FONT>                vlist = new ArrayList(values.size());<a name="line.101"></a>
<FONT color="green">102</FONT>                Iterator iterator = values.listIterator();<a name="line.102"></a>
<FONT color="green">103</FONT>                while (iterator.hasNext()) {<a name="line.103"></a>
<FONT color="green">104</FONT>                    Object obj = iterator.next();<a name="line.104"></a>
<FONT color="green">105</FONT>                    if (obj instanceof Number) {<a name="line.105"></a>
<FONT color="green">106</FONT>                        Number n = (Number) obj;<a name="line.106"></a>
<FONT color="green">107</FONT>                        double v = n.doubleValue();<a name="line.107"></a>
<FONT color="green">108</FONT>                        if (!Double.isNaN(v)) {<a name="line.108"></a>
<FONT color="green">109</FONT>                            vlist.add(n);<a name="line.109"></a>
<FONT color="green">110</FONT>                        }<a name="line.110"></a>
<FONT color="green">111</FONT>                    }<a name="line.111"></a>
<FONT color="green">112</FONT>                }<a name="line.112"></a>
<FONT color="green">113</FONT>            }<a name="line.113"></a>
<FONT color="green">114</FONT>            else {<a name="line.114"></a>
<FONT color="green">115</FONT>                vlist = values;<a name="line.115"></a>
<FONT color="green">116</FONT>            }<a name="line.116"></a>
<FONT color="green">117</FONT>            Collections.sort(vlist);<a name="line.117"></a>
<FONT color="green">118</FONT>    <a name="line.118"></a>
<FONT color="green">119</FONT>            double mean = Statistics.calculateMean(vlist, false);<a name="line.119"></a>
<FONT color="green">120</FONT>            double median = Statistics.calculateMedian(vlist, false);<a name="line.120"></a>
<FONT color="green">121</FONT>            double q1 = calculateQ1(vlist);<a name="line.121"></a>
<FONT color="green">122</FONT>            double q3 = calculateQ3(vlist);<a name="line.122"></a>
<FONT color="green">123</FONT>    <a name="line.123"></a>
<FONT color="green">124</FONT>            double interQuartileRange = q3 - q1;<a name="line.124"></a>
<FONT color="green">125</FONT>    <a name="line.125"></a>
<FONT color="green">126</FONT>            double upperOutlierThreshold = q3 + (interQuartileRange * 1.5);<a name="line.126"></a>
<FONT color="green">127</FONT>            double lowerOutlierThreshold = q1 - (interQuartileRange * 1.5);<a name="line.127"></a>
<FONT color="green">128</FONT>    <a name="line.128"></a>
<FONT color="green">129</FONT>            double upperFaroutThreshold = q3 + (interQuartileRange * 2.0);<a name="line.129"></a>
<FONT color="green">130</FONT>            double lowerFaroutThreshold = q1 - (interQuartileRange * 2.0);<a name="line.130"></a>
<FONT color="green">131</FONT>    <a name="line.131"></a>
<FONT color="green">132</FONT>            double minRegularValue = Double.POSITIVE_INFINITY;<a name="line.132"></a>
<FONT color="green">133</FONT>            double maxRegularValue = Double.NEGATIVE_INFINITY;<a name="line.133"></a>
<FONT color="green">134</FONT>            double minOutlier = Double.POSITIVE_INFINITY;<a name="line.134"></a>
<FONT color="green">135</FONT>            double maxOutlier = Double.NEGATIVE_INFINITY;<a name="line.135"></a>
<FONT color="green">136</FONT>            List outliers = new ArrayList();<a name="line.136"></a>
<FONT color="green">137</FONT>    <a name="line.137"></a>
<FONT color="green">138</FONT>            Iterator iterator = vlist.iterator();<a name="line.138"></a>
<FONT color="green">139</FONT>            while (iterator.hasNext()) {<a name="line.139"></a>
<FONT color="green">140</FONT>                Number number = (Number) iterator.next();<a name="line.140"></a>
<FONT color="green">141</FONT>                double value = number.doubleValue();<a name="line.141"></a>
<FONT color="green">142</FONT>                if (value &gt; upperOutlierThreshold) {<a name="line.142"></a>
<FONT color="green">143</FONT>                    outliers.add(number);<a name="line.143"></a>
<FONT color="green">144</FONT>                    if (value &gt; maxOutlier &amp;&amp; value &lt;= upperFaroutThreshold) {<a name="line.144"></a>
<FONT color="green">145</FONT>                        maxOutlier = value;<a name="line.145"></a>
<FONT color="green">146</FONT>                    }<a name="line.146"></a>
<FONT color="green">147</FONT>                }<a name="line.147"></a>
<FONT color="green">148</FONT>                else if (value &lt; lowerOutlierThreshold) {<a name="line.148"></a>
<FONT color="green">149</FONT>                    outliers.add(number);<a name="line.149"></a>
<FONT color="green">150</FONT>                    if (value &lt; minOutlier &amp;&amp; value &gt;= lowerFaroutThreshold) {<a name="line.150"></a>
<FONT color="green">151</FONT>                        minOutlier = value;<a name="line.151"></a>
<FONT color="green">152</FONT>                    }<a name="line.152"></a>
<FONT color="green">153</FONT>                }<a name="line.153"></a>
<FONT color="green">154</FONT>                else {<a name="line.154"></a>
<FONT color="green">155</FONT>                    minRegularValue = Math.min(minRegularValue, value);<a name="line.155"></a>
<FONT color="green">156</FONT>                    maxRegularValue = Math.max(maxRegularValue, value);<a name="line.156"></a>
<FONT color="green">157</FONT>                }<a name="line.157"></a>
<FONT color="green">158</FONT>                minOutlier = Math.min(minOutlier, minRegularValue);<a name="line.158"></a>
<FONT color="green">159</FONT>                maxOutlier = Math.max(maxOutlier, maxRegularValue);<a name="line.159"></a>
<FONT color="green">160</FONT>            }<a name="line.160"></a>
<FONT color="green">161</FONT>    <a name="line.161"></a>
<FONT color="green">162</FONT>            return new BoxAndWhiskerItem(new Double(mean), new Double(median),<a name="line.162"></a>
<FONT color="green">163</FONT>                    new Double(q1), new Double(q3), new Double(minRegularValue),<a name="line.163"></a>
<FONT color="green">164</FONT>                    new Double(maxRegularValue), new Double(minOutlier),<a name="line.164"></a>
<FONT color="green">165</FONT>                    new Double(maxOutlier), outliers);<a name="line.165"></a>
<FONT color="green">166</FONT>    <a name="line.166"></a>
<FONT color="green">167</FONT>        }<a name="line.167"></a>
<FONT color="green">168</FONT>    <a name="line.168"></a>
<FONT color="green">169</FONT>        /**<a name="line.169"></a>
<FONT color="green">170</FONT>         * Calculates the first quartile for a list of numbers in ascending order.<a name="line.170"></a>
<FONT color="green">171</FONT>         * If the items in the list are not in ascending order, the result is<a name="line.171"></a>
<FONT color="green">172</FONT>         * unspecified.  If the list contains items that are &lt;code&gt;null&lt;/code&gt;, not<a name="line.172"></a>
<FONT color="green">173</FONT>         * an instance of &lt;code&gt;Number&lt;/code&gt;, or equivalent to<a name="line.173"></a>
<FONT color="green">174</FONT>         * &lt;code&gt;Double.NaN&lt;/code&gt;, the result is unspecified.<a name="line.174"></a>
<FONT color="green">175</FONT>         *<a name="line.175"></a>
<FONT color="green">176</FONT>         * @param values  the numbers in ascending order (&lt;code&gt;null&lt;/code&gt; not<a name="line.176"></a>
<FONT color="green">177</FONT>         *     permitted).<a name="line.177"></a>
<FONT color="green">178</FONT>         *<a name="line.178"></a>
<FONT color="green">179</FONT>         * @return The first quartile.<a name="line.179"></a>
<FONT color="green">180</FONT>         */<a name="line.180"></a>
<FONT color="green">181</FONT>        public static double calculateQ1(List values) {<a name="line.181"></a>
<FONT color="green">182</FONT>            if (values == null) {<a name="line.182"></a>
<FONT color="green">183</FONT>                throw new IllegalArgumentException("Null 'values' argument.");<a name="line.183"></a>
<FONT color="green">184</FONT>            }<a name="line.184"></a>
<FONT color="green">185</FONT>    <a name="line.185"></a>
<FONT color="green">186</FONT>            double result = Double.NaN;<a name="line.186"></a>
<FONT color="green">187</FONT>            int count = values.size();<a name="line.187"></a>
<FONT color="green">188</FONT>            if (count &gt; 0) {<a name="line.188"></a>
<FONT color="green">189</FONT>                if (count % 2 == 1) {<a name="line.189"></a>
<FONT color="green">190</FONT>                    if (count &gt; 1) {<a name="line.190"></a>
<FONT color="green">191</FONT>                        result = Statistics.calculateMedian(values, 0, count / 2);<a name="line.191"></a>
<FONT color="green">192</FONT>                    }<a name="line.192"></a>
<FONT color="green">193</FONT>                    else {<a name="line.193"></a>
<FONT color="green">194</FONT>                        result = Statistics.calculateMedian(values, 0, 0);<a name="line.194"></a>
<FONT color="green">195</FONT>                    }<a name="line.195"></a>
<FONT color="green">196</FONT>                }<a name="line.196"></a>
<FONT color="green">197</FONT>                else {<a name="line.197"></a>
<FONT color="green">198</FONT>                    result = Statistics.calculateMedian(values, 0, count / 2 - 1);<a name="line.198"></a>
<FONT color="green">199</FONT>                }<a name="line.199"></a>
<FONT color="green">200</FONT>    <a name="line.200"></a>
<FONT color="green">201</FONT>            }<a name="line.201"></a>
<FONT color="green">202</FONT>            return result;<a name="line.202"></a>
<FONT color="green">203</FONT>        }<a name="line.203"></a>
<FONT color="green">204</FONT>    <a name="line.204"></a>
<FONT color="green">205</FONT>        /**<a name="line.205"></a>
<FONT color="green">206</FONT>         * Calculates the third quartile for a list of numbers in ascending order.<a name="line.206"></a>
<FONT color="green">207</FONT>         * If the items in the list are not in ascending order, the result is<a name="line.207"></a>
<FONT color="green">208</FONT>         * unspecified.  If the list contains items that are &lt;code&gt;null&lt;/code&gt;, not<a name="line.208"></a>
<FONT color="green">209</FONT>         * an instance of &lt;code&gt;Number&lt;/code&gt;, or equivalent to<a name="line.209"></a>
<FONT color="green">210</FONT>         * &lt;code&gt;Double.NaN&lt;/code&gt;, the result is unspecified.<a name="line.210"></a>
<FONT color="green">211</FONT>         *<a name="line.211"></a>
<FONT color="green">212</FONT>         * @param values  the list of values (&lt;code&gt;null&lt;/code&gt; not permitted).<a name="line.212"></a>
<FONT color="green">213</FONT>         *<a name="line.213"></a>
<FONT color="green">214</FONT>         * @return The third quartile.<a name="line.214"></a>
<FONT color="green">215</FONT>         */<a name="line.215"></a>
<FONT color="green">216</FONT>        public static double calculateQ3(List values) {<a name="line.216"></a>
<FONT color="green">217</FONT>            if (values == null) {<a name="line.217"></a>
<FONT color="green">218</FONT>                throw new IllegalArgumentException("Null 'values' argument.");<a name="line.218"></a>
<FONT color="green">219</FONT>            }<a name="line.219"></a>
<FONT color="green">220</FONT>            double result = Double.NaN;<a name="line.220"></a>
<FONT color="green">221</FONT>            int count = values.size();<a name="line.221"></a>
<FONT color="green">222</FONT>            if (count &gt; 0) {<a name="line.222"></a>
<FONT color="green">223</FONT>                if (count % 2 == 1) {<a name="line.223"></a>
<FONT color="green">224</FONT>                    if (count &gt; 1) {<a name="line.224"></a>
<FONT color="green">225</FONT>                        result = Statistics.calculateMedian(values, count / 2,<a name="line.225"></a>
<FONT color="green">226</FONT>                                count - 1);<a name="line.226"></a>
<FONT color="green">227</FONT>                    }<a name="line.227"></a>
<FONT color="green">228</FONT>                    else {<a name="line.228"></a>
<FONT color="green">229</FONT>                        result = Statistics.calculateMedian(values, 0, 0);<a name="line.229"></a>
<FONT color="green">230</FONT>                    }<a name="line.230"></a>
<FONT color="green">231</FONT>                }<a name="line.231"></a>
<FONT color="green">232</FONT>                else {<a name="line.232"></a>
<FONT color="green">233</FONT>                    result = Statistics.calculateMedian(values, count / 2,<a name="line.233"></a>
<FONT color="green">234</FONT>                            count - 1);<a name="line.234"></a>
<FONT color="green">235</FONT>                }<a name="line.235"></a>
<FONT color="green">236</FONT>            }<a name="line.236"></a>
<FONT color="green">237</FONT>            return result;<a name="line.237"></a>
<FONT color="green">238</FONT>        }<a name="line.238"></a>
<FONT color="green">239</FONT>    <a name="line.239"></a>
<FONT color="green">240</FONT>    }<a name="line.240"></a>




























































</PRE>
</BODY>
</HTML>
